CustomerOrderShipment

Entity Definition

Logical Name : CustomerOrderShipment
Physical Name : TR_SHP_CT_ORD

The record of a shipment which was made to deliver the goods purchased in a particular RetailTransaction to the customer's shipping address(es) This reflects that ACTUAL fees and expenses, service levels, delivery source and destination location, etc. for a customer order shipment.

Data Definition

Attribute Description Physical Name Domain Data Type Foreign Key Table
ActualShipTo (FK) A token identifier for a PartyContactMethod entity type instance. ID_PRTY_CNCT_MTH Identity integer PartyContactMethod(CO_MTH_CNCT_PTY)
CarrierAccountNumber (FK) The account number assigned to the retailer by the Carrier for invoicing and delivery service ordering purposes. ID_CRR_ACNT Identity integer CarrierAccount(LE_CRR_ACNT)
ShipmentID (PK) A unique, retailer supplied identifier for a RetailTransactionShipment. ID_SHP Identity integer
SourceInventoryLocationID (FK) A unique system assigned identifier for the InventoryLocation from which the shipment was made. ID_LCN_SRC Identity integer InventoryLocation(LO_LCN_INV)
CarrierTrackingNumber A tracking number provided by the service provider who actually delivers the shipment. ID_TRCK_SHP IdentityAlphaNumeric varchar(20)
TrackingURI A URI to the service provider's website, which allows interested parties to track the shipment. UR_URL_TRCK_SHP DescriptionShort varchar(255)
EstimatedDeliveryDateTime The estimated date & time the shipment will be received at the shipment address. TS_ESTM_RCV AuditDateTime datetime
ScheduledDeliveryDateTime The scheduled date & time the shipment will be received at the shipment address. TS_SCH_RCV AuditDateTime datetime
ActualDeliveryDateTime The actual date & time the shipment was received at the shipment address. TS_ACT_RCV AuditDateTime datetime
ActualPickupDateTime The actual date and time the shipment was picked up by the carrier (as opposed to being delivered to the customer). TS_SHP_ACT AuditDateTime datetime
SpecialInstructions Narrative text, giving special delivery instructions. NA_INST_SPL DescriptionNarrative varchar(4000)
CarrierID (FK) A unique system assigned identifier for the Carrier. ID_CRR Identity integer Carrier(PA_CRR)
CustomerOrderGroupID (FK) A unique system assigned identifier for the group of line items from a Customer placed order, recording how the Customer wishes the StockItems that have been orderd are to be given to the Customer. ID_CTORD_GRP Identity integer CustomerOrderProductGroup(CO_CTORD_GRP)
CustomerAccountInvoiceID (FK) A unique system assigned identifier for the CustomerAccountInvoice ID_INVC_CTAC Identity integer CustomerAccountInvoice(DO_INVC_CTAC)
DeliveryTypeCode A designated category of delivery. Valid values are: PARTIAL_DELIVERY Partial Delivery COMPLETE_DELIVERY_ONLY complete delivery only CD_DV_TYP Name varchar(40)
ActualPaymentMethod (FK) A designated code and enumerated value list that categorizes different ways of paying for transporation services related to a shipment/delivery of merchandise. These typically apply to COD or scenarios where the merchandise is paid for through another means but the customer must pay transport fees on delivery. GS1 examples include: BANK_CHEQUE BANK_GIRO BANKERS_DRAFT BOOKENTRY_CREDIT BOOKENTRY_DEBIT BOP CASH CERTIFIED_CHEQUE CHEQUE CREDIT_CARD DEBIT_CARD ELECTRONIC_CREDIT_ACH ELECTRONIC_DEBIT_ACH FED_WIRE_NON_REPETITIVE FED_WIRE_REPETITIVE INTERNATIONAL_WIRE LETTER_OF_CREDIT POSTGIRO WIRE_TRANSFER_CREDIT WIRE_TRANSFER_DEBIT NM_ACT_PYM_MTH Name varchar(40) TransportPaymentMethod(CO_TRNSPRT_PYM_MTH)
ActualServiceLevel (FK) Identifies a transportation service level type used to distinguish faster from slower delivery plus additional tracking and ancillary services. Sample GS1 code values: AUTHORIZED_RETURN_SERVICE CONSIGNEE_BILLING_SERVICE DELIVERY_CONFIRMATION EXPEDITED_SERVICE EXPEDITED_SERVICE_WORLDWIDE EXPRESS_SERVICE EXPRESS_SERVICE_PLUS GROUND GROUND_CX_EXPRESS_SERVICE MULTIWEIGHT MUTUALLY_DEFINED NEXT_DAY_AIR NEXT_DAY_PM NEXT_MORNING PRIMARY_SERVICE_AREA_NEXT_DAY_BY_1030 PRIMARY_SERVICE_AREA_NEXT_DAY_BY_1700 RETURN_SERVICE SAME_DAY SATURDAY SATURDAY_PICKUP SECOND_DAY_AIR SECOND_MORNING STANDARD_GROUND_HUNDRED_WEIGHT STANDARD_SERVICE THREE_DAY_SERVICE CD_SV_LV Code varchar(20) TransportServiceLevelType(CO_TRNSPRT_PYM_SV_LV_TYP)
BaseShippingFeeExpenseAmount Base shipping fee charged by the carrier exclusive of add-on fees for extra services. MO_BS_SHPPNG_FE_EXP_AMT Money decimal(16,5)
AccessoryFeeExpenseAmount Extra fees added to total shipping expense for extra (accessory) services like extra insurance, signed receipt/confirmation, etc. MO_ACCSSRY_FE_EXP_AMT Money decimal(16,5)
FuelSurchargeAmount Additional charge for fuel that may be required by some carriers. MO_FUEL_SRCHRG_AMT Money decimal(16,5)
CollectOnDeliveryFeeAmount Collect on DeliveryFEE charged to cover collection service at the time of delivery. This is NOT the total collect on delivery amount, that is covered in a different attribute called CollectOnDeliveryAmount MO_CLLCT_ON_DV_FE_AMT Money decimal(16,5)
CollectOnDeliveryAmount The value a carrier must collect from the customer at the time merchandise is delivered. The COD amount typically includes the merchandise cost plus any shipping and handling fees expected to be paid for by the customer. MO_CLLCT_ON_DV_AMT Money decimal(16,5)
ManifestDocumentNumber The identifying number for a manifest document which lists the containers being transported within a shipment. %ColDomain IdentityAlphaNumeric varchar(20)
CarrierServiceID (FK) Token identifier for a CarrierService instance ID_CRR_SV Identity integer CarrierService(CO_CRR_SV)
ShipMethodID (FK) Token identifier for a ShipMethodInstance ID_SHP_MTH Identity integer ShipMethod(CO_SHP_MTH)
AlternatePayment (FK) The account number assigned to the retailer by the Carrier for invoicing and delivery service ordering purposes. A designated alternate account number (not the retailer's CarrierAccountNumber) that is to be charged for transport-related fees and expenses for this shipment. ID_CRR_ACNT Identity integer CarrierAccount(LE_CRR_ACNT)
TransportBillingMethodCode (FK) Retailer designated code that indicates how the transportation and handling fees for a shipment are to be billed. Sample values (for domestic US shipments) include: PREPAID = prepaid transportation fees COL = collect upon delivery from receipient BRC = Bill the receiver B3P = Bill 3rd party Others may be added as required for international shipping and other kinds of shipping arrangements. CD_TRNSPRT_BLLNG_MTH Code varchar(20) TransportBillingMethod(CO_TRNSPRT_BLLNG_MTH)
ResidentialSurchargeAmount A supplementary fee charged by some carriers to cover the additional cost of delivering packages to widely dispersed addresses. MO_RSDNTL_SRCHRG_AMT Money decimal(16,5)
ActualBillTo (FK) A token identifier for a PartyContactMethod entity type instance. ID_PRTY_CNCT_MTH Identity integer PartyContactMethod(CO_MTH_CNCT_PTY)

Relationships

Parent Entity Verb Phrase Child Entity
InventoryLocation is source for CustomerOrderShipment
CustomerOrderProductGroup tentative defines product group for CustomerOrderShipment
PartyContactMethod identifies actual bill to contact CustomerOrderShipment
CustomerAccountInvoice records financial results of CustomerOrderShipment
TransportPaymentMethod defines CustomerOrderShipment
CarrierService specifies CustomerOrderShipment
PartyContactMethod identifiess actual ship to contact CustomerOrderShipment
ShipMethod specifies method for CustomerOrderShipment
CarrierAccount is charged to CustomerOrderShipment
TransportBillingMethod specifies billing method for CustomerOrderShipment
CarrierAccount is alternately charged to CustomerOrderShipment
Carrier ships CustomerOrderShipment
TransportServiceLevelType specifies level for CustomerOrderShipment
CustomerOrderShipment is composed of CustomerOrderShipmentContainer
CustomerOrderShipment delivery specified by CustomerDeliveryInstruction

Logical Views containing CustomerOrderShipment

Logical View
Logical 02020 - Item Inventory - Selling View
Logical 02200 - Transaction Macro View
Logical 02309 - Retail Transaction Delivery
Logical 02315 - Retail Transaction - Customer Order
Logical 02316 - Distributed Order Management View
Logical 02340 - Retail Transaction - Shipping View